home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / dspgvd.z / dspgvd
Encoding:
Text File  |  2002-10-03  |  7.7 KB  |  199 lines
  1.  
  2.  
  3.  
  4. DDDDSSSSPPPPGGGGVVVVDDDD((((3333SSSS))))                                                          DDDDSSSSPPPPGGGGVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      DSPGVD - compute all the eigenvalues, and optionally, the eigenvectors of
  10.      a real generalized symmetric-definite eigenproblem, of the form
  11.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE DSPGVD( ITYPE, JOBZ, UPLO, N, AP, BP, W, Z, LDZ, WORK, LWORK,
  15.                         IWORK, LIWORK, INFO )
  16.  
  17.          CHARACTER      JOBZ, UPLO
  18.  
  19.          INTEGER        INFO, ITYPE, LDZ, LIWORK, LWORK, N
  20.  
  21.          INTEGER        IWORK( * )
  22.  
  23.          DOUBLE         PRECISION AP( * ), BP( * ), W( * ), WORK( * ), Z( LDZ,
  24.                         * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      DSPGVD computes all the eigenvalues, and optionally, the eigenvectors of
  41.      a real generalized symmetric-definite eigenproblem, of the form
  42.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x. Here A and B are
  43.      assumed to be symmetric, stored in packed format, and B is also positive
  44.      definite.
  45.      If eigenvectors are desired, it uses a divide and conquer algorithm.
  46.  
  47.      The divide and conquer algorithm makes very mild assumptions about
  48.      floating point arithmetic. It will work on machines with a guard digit in
  49.      add/subtract, or on those binary machines without guard digits which
  50.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  51.      conceivably fail on hexadecimal or decimal machines without guard digits,
  52.      but we know of none.
  53.  
  54.  
  55. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  56.      ITYPE   (input) INTEGER
  57.              Specifies the problem type to be solved:
  58.              = 1:  A*x = (lambda)*B*x
  59.              = 2:  A*B*x = (lambda)*x
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDSSSSPPPPGGGGVVVVDDDD((((3333SSSS))))                                                          DDDDSSSSPPPPGGGGVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              = 3:  B*A*x = (lambda)*x
  75.  
  76.      JOBZ    (input) CHARACTER*1
  77.              = 'N':  Compute eigenvalues only;
  78.              = 'V':  Compute eigenvalues and eigenvectors.
  79.  
  80.      UPLO    (input) CHARACTER*1
  81.              = 'U':  Upper triangles of A and B are stored;
  82.              = 'L':  Lower triangles of A and B are stored.
  83.  
  84.      N       (input) INTEGER
  85.              The order of the matrices A and B.  N >= 0.
  86.  
  87.      AP      (input/output) DOUBLE PRECISION array, dimension (N*(N+1)/2)
  88.              On entry, the upper or lower triangle of the symmetric matrix A,
  89.              packed columnwise in a linear array.  The j-th column of A is
  90.              stored in the array AP as follows:  if UPLO = 'U', AP(i + (j-
  91.              1)*j/2) = A(i,j) for 1<=i<=j; if UPLO = 'L', AP(i + (j-1)*(2*n-
  92.              j)/2) = A(i,j) for j<=i<=n.
  93.  
  94.              On exit, the contents of AP are destroyed.
  95.  
  96.      BP      (input/output) DOUBLE PRECISION array, dimension (N*(N+1)/2)
  97.              On entry, the upper or lower triangle of the symmetric matrix B,
  98.              packed columnwise in a linear array.  The j-th column of B is
  99.              stored in the array BP as follows:  if UPLO = 'U', BP(i + (j-
  100.              1)*j/2) = B(i,j) for 1<=i<=j; if UPLO = 'L', BP(i + (j-1)*(2*n-
  101.              j)/2) = B(i,j) for j<=i<=n.
  102.  
  103.              On exit, the triangular factor U or L from the Cholesky
  104.              factorization B = U**T*U or B = L*L**T, in the same storage
  105.              format as B.
  106.  
  107.      W       (output) DOUBLE PRECISION array, dimension (N)
  108.              If INFO = 0, the eigenvalues in ascending order.
  109.  
  110.      Z       (output) DOUBLE PRECISION array, dimension (LDZ, N)
  111.              If JOBZ = 'V', then if INFO = 0, Z contains the matrix Z of
  112.              eigenvectors.  The eigenvectors are normalized as follows:  if
  113.              ITYPE = 1 or 2, Z**T*B*Z = I; if ITYPE = 3, Z**T*inv(B)*Z = I.
  114.              If JOBZ = 'N', then Z is not referenced.
  115.  
  116.      LDZ     (input) INTEGER
  117.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  118.              'V', LDZ >= max(1,N).
  119.  
  120.      WORK    (workspace/output) DOUBLE PRECISION array, dimension (LWORK)
  121.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  122.  
  123.      LWORK   (input) INTEGER
  124.              The dimension of the array WORK.  If N <= 1,               LWORK
  125.              >= 1.  If JOBZ = 'N' and N > 1, LWORK >= 2*N.  If JOBZ = 'V' and
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDSSSSPPPPGGGGVVVVDDDD((((3333SSSS))))                                                          DDDDSSSSPPPPGGGGVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              N > 1, LWORK >= 1 + 6*N + 2*N**2.
  141.  
  142.              If LWORK = -1, then a workspace query is assumed; the routine
  143.              only calculates the optimal size of the WORK array, returns this
  144.              value as the first entry of the WORK array, and no error message
  145.              related to LWORK is issued by XERBLA.
  146.  
  147.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  148.              On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.
  149.  
  150.      LIWORK  (input) INTEGER
  151.              The dimension of the array IWORK.  If JOBZ  = 'N' or N <= 1,
  152.              LIWORK >= 1.  If JOBZ  = 'V' and N > 1, LIWORK >= 3 + 5*N.
  153.  
  154.              If LIWORK = -1, then a workspace query is assumed; the routine
  155.              only calculates the optimal size of the IWORK array, returns this
  156.              value as the first entry of the IWORK array, and no error message
  157.              related to LIWORK is issued by XERBLA.
  158.  
  159.      INFO    (output) INTEGER
  160.              = 0:  successful exit
  161.              < 0:  if INFO = -i, the i-th argument had an illegal value
  162.              > 0:  DPPTRF or DSPEVD returned an error code:
  163.              <= N:  if INFO = i, DSPEVD failed to converge; i off-diagonal
  164.              elements of an intermediate tridiagonal form did not converge to
  165.              zero; > N:   if INFO = N + i, for 1 <= i <= N, then the leading
  166.              minor of order i of B is not positive definite.  The
  167.              factorization of B could not be completed and no eigenvalues or
  168.              eigenvectors were computed.
  169.  
  170. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  171.      Based on contributions by
  172.         Mark Fahey, Department of Mathematics, Univ. of Kentucky, USA
  173.  
  174.  
  175. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  176.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  177.  
  178.      This man page is available only online.
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.